docs: update go table driven tests link in CODING_GUIDELINES.md
#22040
Conversation
📝 WalkthroughWalkthroughThe Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CODING_GUIDELINES.md (2)
107-107: Approve link update and suggest hyphenation correctionThe update to the table-driven tests link is correct and now points to the official Go documentation. This change improves the accuracy of the guidelines.
Additionally, for consistency with common usage and to address the static analysis hint:
Consider applying this minor change:
-[table driven tests](https://go.dev/wiki/TableDrivenTests) +[table-driven tests](https://go.dev/wiki/TableDrivenTests)This hyphenation is more commonly used and aligns with the spelling in the linked documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: The adjective “table-driven” is spelled with a hyphen.
Context: ... of different inputs, we prefer to use [table driven tests](https://go.dev/wiki/TableDrivenT...(DRIVEN_HYPHEN)
[uncategorized] ~107-~107: The adjective “Table-driven” is spelled with a hyphen.
Context: ...(https://go.dev/wiki/TableDrivenTests). Table driven test error messages should follow the f...(DRIVEN_HYPHEN)
107-107: Suggest consistent hyphenationFor consistency with the previous suggestion and to address the static analysis hint:
Consider applying this minor change:
-Table driven test error messages should follow the following format +Table-driven test error messages should follow the following formatThis maintains consistency in hyphenation throughout the document.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: The adjective “table-driven” is spelled with a hyphen.
Context: ... of different inputs, we prefer to use [table driven tests](https://go.dev/wiki/TableDrivenT...(DRIVEN_HYPHEN)
[uncategorized] ~107-~107: The adjective “Table-driven” is spelled with a hyphen.
Context: ...(https://go.dev/wiki/TableDrivenTests). Table driven test error messages should follow the f...(DRIVEN_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- CODING_GUIDELINES.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
CODING_GUIDELINES.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
CODING_GUIDELINES.md
[uncategorized] ~107-~107: The adjective “table-driven” is spelled with a hyphen.
Context: ... of different inputs, we prefer to use [table driven tests](https://go.dev/wiki/TableDrivenT...(DRIVEN_HYPHEN)
[uncategorized] ~107-~107: The adjective “Table-driven” is spelled with a hyphen.
Context: ...(https://go.dev/wiki/TableDrivenTests). Table driven test error messages should follow the f...(DRIVEN_HYPHEN)
Description
https://github.com/golang/go/wiki/TableDrivenTestsis no longer valid, replaced byhttps://go.dev/wiki/TableDrivenTestsSummary by CodeRabbit
CODING_GUIDELINES.mdto enhance clarity on coding practices, performance, security, documentation, acceptance tests, automated tests, and quality assurance.